Gas Device Raw QTR report templates contain a ReportDefinition page and a ReportSheet page, that together describe the reports you can produce. CygNet provides a sample report template file RawQtrGasTemplate.xlsx for reference. It is stored in the CygNet\Services\FMS\ReportTemplates\Samples folder on your host server.
The ReportDefinition sheet includes the following parameters to describe the type of report to build.
The ReportSheet sheet includes the following sections and corresponding tokens to describe the specific format of the report to build. Valid tokens will be replaced by the values they represent. You may also include additional information you wish to see in the report.
You can enter additional (non-token) elements such as logos, labels, or text into reports. Elements that are not valid token values will be displayed as entered.
Note: This means that tokens with typographical errors, therefore not "valid" tokens, will also be displayed as entered.
Example
[Volume] is a valid token. If you use [Vol] (not a valid token) instead of [Volume], the value will be displayed as "[Vol]" instead of displaying the volume value desired, since [Vol] is not a valid token.
|
[Vol] |
Data item tokens have variants you can use to display the beginning or ending values for a record. Append _Begin to the token text to show the beginning value for the record period. Append _End to the token text to show the ending value for the record period. You can then view data values or configuration settings in effect at either the beginning or end of each record span (e.g. hourly, daily) as desired. If neither _Begin nor _End is appended, the default is the ending value for the record.
The ReportDefinition uses parameters to describe the type of report for the service to build. The following parameters determine the described characteristics of your report.
Report parameters, which appear between #ReportParameters# and #End#, can be defined by the following values.
| Parameter | Description | Value |
|---|---|---|
|
ReportName |
The value defined in this cell will be used for the report name, as it will appear in drop-down menus in FMS Explorer and CygNet Explorer. See Using the Reports Control and Scheduling FMS Command Tasks in the MSS for more information. |
Enter a value to be used for the report name. Example Gas Device Raw QTR |
|
CommandName |
The value defined in this cell will be used by the service to determine which specific report command type to execute. See FMSClient Methods in the Scripting section for more information. |
Enter a value to specify the report command name. Example RQTR Note: Maximum of 7 characters; letters or numbers only, no spaces. |
Gas Device Raw QTR report worksheet parameters, which appear between #Worksheet# and #End#, can be defined by the following values.
| Parameter | Description | Value |
|---|---|---|
|
ReportType |
The value defined in this cell will be used to represent the standard FMS report type you are configuring. |
Enter a value to be used to indicate the type of the report. Example Gas Device Raw QTR |
|
NullToken |
The value defined in this cell will be used to represent null values in your report. |
Enter a value to be used to indicate a "null value" cell in the report. Example - |
|
PageBreaks Note: Superseded by the SpanPageBreaks parameter, if its value is set to Yes |
The value defined in this cell will be used to specify whether or not to use page breaks in your report. If used, will force a page break after each device within a group. |
Enter a value to indicate whether or not to use page breaks in the report. Options are Yes or No. Default value is Yes. |
|
SpanPageBreaks Note: If set to Yes, supersedes the PageBreaks parameter |
The value defined in this cell will be used to specify whether or not to use page breaks in your report corresponding to the device record span. If used, will force a page break after each day for hourly records, and after each month for daily records. Each additional page break will display new SubReport and Data Table headers/footers using span-appropriate data. |
Enter a value to indicate whether or not to use page breaks in the report that relate to the device record span. Options are Yes or No. Default value is No. |
|
MixedValueToken |
The value defined in this cell will be used to represent mixed values in your report. |
Enter a value to be used to indicate a "mixed value" cell in the report. Example [Mixed] |
|
The value defined in this cell will be used in your report to represent the value for the Group name or Group description fields when either of the following is true.
|
Enter a value to be used to indicate the Group name or Group description when the command was not run against a single group Node. Example [Invalid Group] |
|
|
NodeSortOrder |
The value defined in this cell will be used to specify the order in which to display Node results in the report. |
Enter one of the following options.
Default value is Name ascending. This parameter is optional. |
|
RptStDate |
Note: If you use this parameter in your report template, the RptStDate parameter will no longer appear for configuration in FMS Explorer or CygNet Explorer. See Gas Device Raw QTR Report Definitions (FMS Explorer) or Reports: Gas Device Raw QTR (CygNet Explorer) for more information. |
If used, enter a valid start date value for the report. RptStDate and RptEndDate must be the same configuration parameter type. Notes: The report will display data in Device time (D), although the report command parameters are configured relative to Contract time (C). The report will only include records that exist entirely within the specified date range. See Selecting Date and Time for more information. This parameter is optional. |
|
RptEndDate |
Note: If you use this parameter in your report template, the RptEndDate parameter will no longer appear for configuration in FMS Explorer or CygNet Explorer. See Report Definitions (FMS Explorer) or Reports: Gas Device Raw QTR (CygNet Explorer) for more information. |
If used, enter a valid end date value for the report. StartDate and EndDate must be the same configuration parameter type. Notes: The report will display data in Device time (D), although the report command parameters are configured relative to Contract time (C). The report will only include records that exist entirely within the specified date range. See Selecting Date and Time for more information. This parameter is optional. |
|
RptUnitSet |
Note: If you use this parameter in your report template, the RptUnitSet parameter will no longer appear for configuration in FMS Explorer or CygNet Explorer. See Gas Device Raw QTR Report Definitions (FMS Explorer) or Reports: Gas Device Raw QTR (CygNet Explorer) for more information. |
If used, enter a valid unit set value for the report. Valid unit set values defined in the service can be viewed through the Admin menu in FMS Explorer. See Configuring Unit Set Definitions for more information. This parameter is optional. |
The ReportSheet uses tokens to describe the format of the report you want to run. The following tokens determine the report content, and will retrieve the corresponding values for display in your report.
Note: Enter report tokens carefully, as the tokens are case sensitive. Typographical errors (therefore not "valid" tokens) will be handled as "additional values" and displayed as entered; the non-token value will appear in your report instead of the actual value(s) the correctly entered token would have retrieved. See Displaying Additional (Non-Token) Values above for more information.
Gas Device Raw QTR report headers, which appear above #EndReportHdr#, can be described by the following tokens.
| Token | Description |
|---|---|
| [BeginDateTime] | Start date, in Contract day (C), of the requested time range for the report, when using leading time of the record |
| [EndDateTime] | End date, in Contract day (C), of the requested time range for the report, when using trailing time of the record |
| [CmdGroupName] | Name of the group Node against which the command was run, if applicable See also NoCmdGroupToken parameter. |
| [CmdGroupDesc] | Description of the group Node against which the command was run, if applicable See also NoCmdGroupToken parameter. |
| [GeneratedDateTime] | Time the report was generated, in Local time (L) |
| [TotalDeviceCount] | Total number of devices in the report |
Gas Device Raw QTR report subreport headers, which appear between #SubSection# SubReportHeader and #End#, can be described by the following tokens.
| Token | Description |
|---|---|
| General Tokens | |
| [=] | When used as the first three characters, turns the cell into a formula |
| [RowNumber] | Current row number |
| [CurrentDeviceCount] | Index of the device being displayed |
| [TotalDeviceCount] | Total number of devices in the report |
| [DeviceType] [DeviceType_Begin] [DeviceType_End] Note: This token can be inserted in an Excel formula that uses the device type value returned to determine whether pressure or pulse data will be shown in the data table, and displays the corresponding label in the column header. |
Type of device |
| [NodeContractHour] | Contract hour of the Node |
| [NodeDaysOfData] | Number of days for which the data source of the Node will retain data |
| [NodeDesc] | Node description |
| [NodeId] | Node ID |
| [NodeInstallDateTime] | Install date/time for the Node, in Device time (D) |
| [NodeName] | Node name |
| [NodePollingFacilityId] | Polling facility ID of the Node |
| [NodePollingFacilityTag] | Polling facility tag of the Node |
| [NodePollingSiteService] | Polling Site.Service of the Node |
| [NodeReportingFacilityId] | Reporting facility ID of the Node |
| [NodeReportingSiteService] | Reporting Site.Service of the Node |
| [NodeSecurityApp] | Security application of the Node |
| [NodeSortPriority] | Sort priority of the Node |
| [NodeTimezone] | Time zone configured for the Node |
| [NodeTimezoneUsingDst] | Daylight saving time status of the Node |
| [NodeType] | Node type |
| [PollingFac_Attr0] - [PollingFac_Attr29] |
Polling facility indexed text attributes 0 through 29 (each a separate token) |
| [PollingFac_Category] | Polling facility category |
| [PollingFac_Desc] | Polling facility description |
| [PollingFac_Info0] | Polling facility info attribute 0 Default attribute name is Facility Location |
| [PollingFac_Info1] | Polling facility info attribute 1 Default attribute name is Facility Contact |
| [PollingFac_IsActive] | Polling facility active flag |
| [PollingFac_Table0] - [PollingFac_Table29] |
Polling facility indexed table attributes 0 through 29 (each a separate token) |
| [PollingFac_Type] | Polling facility type |
| [PollingFac_YesNo0] - [PollingFac_YesNo19] |
Polling facility indexed Yes/No attributes 0 through 19 (each a separate token) |
| [RecordSpan] | Number of minutes in the record span |
| Units Tokens - Gas Metering | |
| [Dp_Units] | Units used for differential pressure data |
| [Energy_Units] | Units used for energy data |
| [FlowRate_Units] | Units used for flow rate data |
| [FlowTime_Units] | Units used for flow time data |
| [KFactorMass_Units] | Units used for K factor mass |
| [KFactorVolume_Units] | Units used for K factor volume |
| [Mass_Units] | Units used for mass data |
| [Sp_Units] | Units used for static pressure data |
| [Temp_Units] | Units used for temperature data |
| [UncorrectedVolume_Units] | Units used for uncorrected volume data |
| [Volume_Units] | Units used for volume data |
Gas Device Raw QTR report data table headers, which appear between #SubSection# DataTableHeader and #End#, can be described by the following tokens.
Note: In PDF format, reports containing tables that span multiple pages will repeat the data table header on each contiguous page.
| Token | Description |
|---|---|
| General Tokens | |
| [=] | When used as the first three characters, turns the cell into a formula |
| [RowNumber] | Current row number |
| Units Tokens - Gas Metering | |
| [Dp_Units] | Units used for differential pressure data |
| [Energy_Units] | Units used for energy data |
| [FlowRate_Units] | Units used for flow rate data |
| [FlowTime_Units] | Units used for flow time data |
| [KFactorMass_Units] | Units used for K factor mass |
| [KFactorVolume_Units] | Units used for K factor volume |
| [Mass_Units] | Units used for mass data |
| [Sp_Units] | Units used for static pressure data |
| [Temp_Units] | Units used for temperature data |
| [UncorrectedVolume_Units] | Units used for uncorrected volume data |
| [Volume_Units] | Units used for volume data |
| Units Tokens - Gas Quality | |
| [Methane_Units] | Units used for Methane (C1) data |
| [Ethane_Units] | Units used for Ethane (C2) data |
| [Propane_Units] | Units used for Propane (C3) data |
| [n-Butane_Units] | Units used for n-Butane (C4) data |
| [Isobutane_Units] | Units used for Isobutane (isoC4) data |
| [n-Pentane_Units] | Units used for n-Pentane (C5) data |
| [Isopentane_Units] | Units used for Isopentane (isoC5) data |
| [Neopentane_Units] | Units used for Neopentane (neoC5) data |
| [n-Hexane_Units] | Units used for n-Hexane (C6) data |
| [n-Heptane_Units] | Units used for n-Heptane (C7) data |
| [n-Octane_Units] | Units used for n-Octane (C8) data |
| [n-Nonane_Units] | Units used for n-Nonane (C9) data |
| [n-Decane_Units] | Units used for n-Decane (C10) data |
| [Argon_Units] | Units used for Argon (Ar) data |
| [CarbonDioxide_Units] | Units used for Carbon dioxide (CO2) data |
| [CarbonMonoxide_Units] | Units used for Carbon monoxide (CO) data |
| [Helium_Units] | Units used for Helium (He) data |
| [Hydrogen_Units] | Units used for Hydrogen (H2) data |
| [HydrogenSulfide_Units] | Units used for Hydrogen sulfide (H2S) data |
| [Nitrogen_Units] | Units used for Nitrogen (N2) data |
| [Oxygen_Units] | Units used for Oxygen (O2) data |
| [Water_Units] | Units used for Water (H2O) data |
| [HeatingValueMass_Units] | Units used for heating value mass data |
| [HeatingValueVolume_Units] | Units used for heating value volume data |
| [Viscosity_Units] | Units used for viscosity data |
Gas Device Raw QTR report data table parameters, which appear between #SubSection# DataTable (1 or 2) and #End#, can be described by the following tokens.
| Token | Description |
|---|---|
| General Tokens | |
| [=] | When used as the first three characters, turns the cell into a formula |
| [FirstRow] | Row number of the first row in the data table |
| [RowNumber] | Current row number |
| [DeviceType] [DeviceType_Begin] [DeviceType_End] |
Type of device
Note: This token can be inserted in an Excel formula that uses the device type value returned to determine whether pressure or pulse data will be shown in the data table, and displays the corresponding label in the column header. |
| [DataSource] | Source of data for the record |
| [GasQualitySource] | Source of data for the GQ record |
| [BeginNormalizedDateTime] | Beginning date/time (normalized) of the raw record, in Device time (D) |
| [NodePollingFacilityId] | Polling facility ID of the Node |
| [NodePollingFacilityTag] | Polling facility tag of the Node |
| [NodePollingSiteService] | Polling Site.Service of the Node |
| [NodeReportingFacilityId] | Reporting facility ID of the Node |
| [NodeReportingSiteService] | Reporting Site.Service of the Node |
| [PollingFac_Attr0] - [PollingFac_Attr29] |
Polling facility indexed text attributes 0 through 29 (each a separate token) |
| [PollingFac_Category] | Polling facility category |
| [PollingFac_Desc] | Polling facility description |
| [PollingFac_Info0] | Polling facility info attribute 0 Default attribute name is Facility Location |
| [PollingFac_Info1] | Polling facility info attribute 1 Default attribute name is Facility Contact |
| [PollingFac_IsActive] | Polling facility active flag |
| [PollingFac_Table0] - [PollingFac_Table29] |
Polling facility indexed table attributes 0 through 29 (each a separate token) |
| [PollingFac_Type] | Polling facility type |
| [PollingFac_YesNo0] - [PollingFac_YesNo19] |
Polling facility indexed Yes/No attributes 0 through 19 (each a separate token) |
| [RawBeginDateTime] | Start date of the time range for the raw record, in Device time (D) |
| [RawEndDateTime] | End date of the time range for the raw record, in Device time (D) |
| [RecordSpan] | Span for the raw record, e.g. hourly, daily |
| Gas Metering Tokens | |
| [GasMetering_AuditCategory] | Audit category associated with the raw gas metering record |
| [GasMetering_AuditComments] | Audit comment associated with the raw gas metering record |
| [GasMetering_AuditDate_Host] | Audit date associated with the raw gas metering record (using the host server time zone) |
| [GasMetering_AuditUserName] | Audit user name associated with the raw gas metering record |
| [DischargeCoefficient] | Discharge coefficient |
| [Dp] | Differential pressure |
| [Energy] | Energy |
| [FlowRate] | Flow rate |
| [FlowTime] | Flow time |
| [IMV] | Integral Multiplier Value |
| [IV] | Integral Value Definition Defines the calculation variables used, where applicable |
| [LinearCurveType] | Linear curve type |
| [KFactorMass] | K factor mass |
| [KFactorVolume] | K factor volume |
| [Mass] | Mass |
| [MeterFactor] | Meter factor |
| [PulseCount] | Pulse count |
| [Sp] | Static pressure |
| [Temp] | Temperature |
| [UncorrectedVolume] | Uncorrected volume |
| [Volume] | Volume |
| [CustomGM1] | Custom-defined GM process variables See Remote Devices for your device type and EFM Data Items for more information. |
| [CustomGM2] | |
| [CustomGM3] | |
| [CustomGM4] | |
| [CustomGM5] | |
| Gas Quality Tokens | |
| [GasQuality_AuditCategory] | Audit category associated with the raw gas quality record |
| [GasQuality_AuditComments] | Audit comment associated with the raw gas quality record |
| [GasQuality_AuditDate_Host] | Audit date associated with the raw gas quality record (using the host server time zone) |
| [GasQuality_AuditUserName] | Audit user name associated with the raw gas quality record |
| [Methane] | Methane (C1) |
| [Ethane] | Ethane (C2) |
| [Propane] | Propane (C3) |
| [n-Butane] | n-Butane (C4) |
| [Isobutane] | Isobutane (isoC4) |
| [n-Pentane] | n-Pentane (C5) |
| [Isopentane] | Isopentane (isoC5) |
| [Neopentane] | Neopentane (neoC5) |
| [n-Hexane] | n-Hexane (C6) |
| [n-Heptane] | n-Heptane (C7) |
| [n-Octane] | n-Octane (C8) |
| [n-Nonane] | n-Nonane (C9) |
| [n-Decane] | n-Decane (C10) |
| [Argon] | Argon (Ar) |
| [CarbonDioxide] | Carbon dioxide (CO2) |
| [CarbonMonoxide] | Carbon monoxide (CO) |
| [Helium] | Helium (He) |
| [Hydrogen] | Hydrogen (H2) |
| [HydrogenSulfide] | Hydrogen sulfide (H2S) |
| [Nitrogen] | Nitrogen (N2) |
| [Oxygen] | Oxygen (O2) |
| [Water] | Water (H2O) |
| [HeatingValueMass] | Heating value mass |
| [HeatingValueVolume] | Heating value volume |
| [Compressibility] | Compressibility |
| [DewPoint] | Dew point |
| [RelativeDensity] | Relative density |
| [Viscosity] | Viscosity |
| [C6Plus] | Higher hydrocarbons (C6+) |
| [C7Plus] | Higher hydrocarbons (C7+) |
| [C9Plus] | Higher hydrocarbons (C9+) |
| [CustomGQ1] | Custom-defined GQ process variables See Remote Devices for your device type and EFM Data Items for more information. |
| [CustomGQ2] | |
| [CustomGQ3] | |
| [CustomGQ4] | |
| [CustomGQ5] | |
Gas Device Raw QTR report subreport footers, which appear between #SubSection# SubReportFooter and #End#, can be described by the following tokens.
| Token | Description |
|---|---|
| General Tokens | |
| [=] | When used as the first three characters, turns the cell into a formula |
| [FirstRow] | Row number of the first row in the data table |
| [LastRow] | Row number of the last row in the data table |
| [RowNumber] | Current row number |
| [CurrentDeviceCount] | Index of the device being displayed |
| [TotalDeviceCount] | Total number of devices in the report |
| [NodeContractHour] | Contract hour of the Node |
| [NodeDaysOfData] | Number of days for which the data source of the Node will retain data |
| [NodeDesc] | Node description |
| [NodeId] | Node ID |
| [NodeInstallDateTime] | Install date/time for the Node, in Device time (D) |
| [NodeName] | Node name |
| [NodePollingFacilityId] | Polling facility ID of the Node |
| [NodePollingFacilityTag] | Polling facility tag of the Node |
| [NodePollingSiteService] | Polling Site.Service of the Node |
| [NodeReportingFacilityId] | Reporting facility ID of the Node |
| [NodeReportingSiteService] | Reporting Site.Service of the Node |
| [NodeSecurityApp] | Security application of the Node |
| [NodeSortPriority] | Sort priority of the Node |
| [NodeTimezone] | Time zone configured for the Node |
| [NodeTimezoneUsingDst] | Daylight saving time status of the Node |
| [NodeType] | Node type |
| [PollingFac_Attr0] - [PollingFac_Attr29] |
Polling facility indexed text attributes 0 through 29 (each a separate token) |
| [PollingFac_Category] | Polling facility category |
| [PollingFac_Desc] | Polling facility description |
| [PollingFac_Info0] | Polling facility info attribute 0 Default attribute name is Facility Location |
| [PollingFac_Info1] | Polling facility info attribute 1 Default attribute name is Facility Contact |
| [PollingFac_IsActive] | Polling facility active flag |
| [PollingFac_Table0] - [PollingFac_Table29] |
Polling facility indexed table attributes 0 through 29 (each a separate token) |
| [PollingFac_Type] | Polling facility type |
| [PollingFac_YesNo0] - [PollingFac_YesNo19] |
Polling facility indexed Yes/No attributes 0 through 19 (each a separate token) |
| [RecordSpan] | Number of minutes in the record span |
| Units Tokens - Gas Metering | |
| [Dp_Units] | Units used for differential pressure data |
| [Energy_Units] | Units used for energy data |
| [FlowRate_Units] | Units used for flow rate data |
| [FlowTime_Units] | Units used for flow time data |
| [KFactorMass_Units] | Units used for K factor mass |
| [KFactorVolume_Units] | Units used for K factor volume |
| [Mass_Units] | Units used for mass data |
| [Sp_Units] | Units used for static pressure data |
| [Temp_Units] | Units used for temperature data |
| [UncorrectedVolume_Units] | Units used for uncorrected volume data |
| [Volume_Units] | Units used for volume data |
| Units Tokens - Gas Quality | |
| [Methane_Units] | Units used for Methane (C1) data |
| [Ethane_Units] | Units used for Ethane (C2) data |
| [Propane_Units] | Units used for Propane (C3) data |
| [n-Butane_Units] | Units used for n-Butane (C4) data |
| [Isobutane_Units] | Units used for Isobutane (isoC4) data |
| [n-Pentane_Units] | Units used for n-Pentane (C5) data |
| [Isopentane_Units] | Units used for Isopentane (isoC5) data |
| [Neopentane_Units] | Units used for Neopentane (neoC5) data |
| [n-Hexane_Units] | Units used for n-Hexane (C6) data |
| [n-Heptane_Units] | Units used for n-Heptane (C7) data |
| [n-Octane_Units] | Units used for n-Octane (C8) data |
| [n-Nonane_Units] | Units used for n-Nonane (C9) data |
| [n-Decane_Units] | Units used for n-Decane (C10) data |
| [Argon_Units] | Units used for Argon (Ar) data |
| [CarbonDioxide_Units] | Units used for Carbon dioxide (CO2) data |
| [CarbonMonoxide_Units] | Units used for Carbon monoxide (CO) data |
| [Helium_Units] | Units used for Helium (He) data |
| [Hydrogen_Units] | Units used for Hydrogen (H2) data |
| [HydrogenSulfide_Units] | Units used for Hydrogen sulfide (H2S) data |
| [Nitrogen_Units] | Units used for Nitrogen (N2) data |
| [Oxygen_Units] | Units used for Oxygen (O2) data |
| [Water_Units] | Units used for Water (H2O) data |
| [HeatingValueMass_Units] | Units used for heating value mass data |
| [HeatingValueVolume_Units] | Units used for heating value volume data |
| [Viscosity_Units] | Units used for viscosity data |
| Gas Quality Tokens | |
| [Methane] | Methane (C1) |
| [Ethane] | Ethane (C2) |
| [Propane] | Propane (C3) |
| [n-Butane] | n-Butane (C4) |
| [Isobutane] | Isobutane (isoC4) |
| [n-Pentane] | n-Pentane (C5) |
| [Isopentane] | Isopentane (isoC5) |
| [Neopentane] | Neopentane (neoC5) |
| [n-Hexane] | n-Hexane (C6) |
| [n-Heptane] | n-Heptane (C7) |
| [n-Octane] | n-Octane (C8) |
| [n-Nonane] | n-Nonane (C9) |
| [n-Decane] | n-Decane (C10) |
| [Argon] | Argon (Ar) |
| [CarbonDioxide] | Carbon dioxide (CO2) |
| [CarbonMonoxide] | Carbon monoxide (CO) |
| [Helium] | Helium (He) |
| [Hydrogen] | Hydrogen (H2) |
| [HydrogenSulfide] | Hydrogen sulfide (H2S) |
| [Nitrogen] | Nitrogen (N2) |
| [Oxygen] | Oxygen (O2) |
| [Water] | Water (H2O) |
| [HeatingValueMass] | Heating value mass |
| [HeatingValueVolume] | Heating value volume |
| [Compressibility] | Compressibility |
| [DewPoint] | Dew point |
| [RelativeDensity] | Relative density |
| [Viscosity] | Viscosity |
| [CustomGQ1] | Custom-defined GQ process variables See Remote Devices for your device type and EFM Data Items for more information. |
| [CustomGQ2] | |
| [CustomGQ3] | |
| [CustomGQ4] | |
| [CustomGQ5] | |
Gas Device Raw QTR report footers, which appear between #SubSection# ReportFooter and #End#, can be described by the text you enter. Type the desired text into the cell, and format it as desired.
|
|
|
